Skip to main content

Get User ExtraField Value list

GET : http://<base_url>/digipay/v3/user/user_extra_field_value

This API is utilized to store new user extrafield values within the system.

QUERY PARAMS:-

ParameterTypeDescriptionValue
user_idStringRepresents the unique identifier of the user, e.g., ""user123"". user_extra_field_values: This is a list of maps where each map represents an extra field associated with the user. In this example, there are two fields: age: Represents the age of the user, with a value of 25.123
query_filterJsonThis is a list of maps where each map represents an extra field associated with the user. In this example, there are two fields2
is_activeBooleanif value is true it will show active languages in response, if value is false it will show inActive langauages in responsetrue/false
skipIntSkip the first n document from the query result1
limitIntLimits the number of records or documents that you want1
start_dateLonga Unix timestamp value in second1
end_dateLonga Unix timestamp value in second1
sortingStringSorting of the Data in the form of a string123
search_keywordStringa keyword which can be either name of language or a language code to get desired language as output123

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/user_extra_field_value?user_id=123&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json'

Response:-

Response 200(OK)


{
"success": 1,
"error": [],
"data": {
"user_extra_field_value": [
{
"id": "2191e668d3794f50b8fe63c3a6556c55"
"extra_field_key": "key1",
"field_value" : "03/01/2022",
"user_id" : "22f4e20aa2be4c8abd8155b8e3dee425",
"kyc_status": "22f4e20aa2be4c8abd8155b8e3dee425",
"extra_field_option_name": "Cricket"
}
]
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR